API Documentation
Resource.h
1 // Resource.h
3 //
5 
6 namespace nkGraphics
7 {
11  class DLL_GRAPHICS_EXPORT Resource
12  {
13  public :
14 
18  Resource () ;
24  Resource (const char* path) ;
28  virtual ~Resource () ;
29 
42  virtual bool load () = 0 ;
46  virtual void unload () = 0 ;
47 
48  // Getter
52  bool isReadyForRendering () const ;
56  bool isUnloaded () const ;
64  std::string_view getResourcePath () const ;
72  std::string_view getResourceName () const ;
76  bool getHidden () const ;
77 
78  // Setters
84  virtual void setResourcePath (const std::string_view& path) ;
90  void setResourceName (const std::string_view& name) ;
96  void setHidden (bool value) ;
97  } ;
98 }
nkGraphics::Resource::isUnloaded
bool isUnloaded() const
nkGraphics::Resource::~Resource
virtual ~Resource()
nkGraphics::Resource::getLoadState
RESOURCE_LOAD_STATE getLoadState() const
nkGraphics::RESOURCE_TYPE
RESOURCE_TYPE
The type of resources available in the component.
Definition: ResourceType.h:12
nkGraphics::Resource::isReadyForRendering
bool isReadyForRendering() const
nkGraphics::Resource::getResourceName
std::string_view getResourceName() const
nkGraphics::Resource::setResourcePath
virtual void setResourcePath(const std::string_view &path)
nkGraphics::Resource::Resource
Resource(const char *path)
nkGraphics::RESOURCE_LOAD_STATE
RESOURCE_LOAD_STATE
The resource load states possible.
Definition: ResourceLoadState.h:12
nkGraphics::Resource::getResourcePath
std::string_view getResourcePath() const
nkGraphics::Resource::load
virtual bool load()=0
nkGraphics::Resource::getHidden
bool getHidden() const
nkGraphics::Resource::getResourceTypeName
RESOURCE_TYPE getResourceTypeName() const
nkGraphics::Resource
Base class for a resource in the component.
Definition: Resource.h:12
nkGraphics::Resource::unload
virtual void unload()=0
nkGraphics::Resource::setHidden
void setHidden(bool value)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::Resource::setResourceName
void setResourceName(const std::string_view &name)
nkGraphics::Resource::Resource
Resource()